<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2008 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: HL7Field.html 21 2014-09-19 19:17:15Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.hl7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.Serializable;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.Arrays;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>/**<a name="line.13"></a>
<span class="sourceLineNo">014</span> * Represents one field in an HL7 message, possibly with repeats.<a name="line.14"></a>
<span class="sourceLineNo">015</span> *<a name="line.15"></a>
<span class="sourceLineNo">016</span> * &lt;p&gt;<a name="line.16"></a>
<span class="sourceLineNo">017</span> * Instances of this class are "immutable"; however, for this to be<a name="line.17"></a>
<span class="sourceLineNo">018</span> * true the calling application must not alter the arrays passed to<a name="line.18"></a>
<span class="sourceLineNo">019</span> * the constructor or returned from any of the methods.<a name="line.19"></a>
<span class="sourceLineNo">020</span> */<a name="line.20"></a>
<span class="sourceLineNo">021</span>@SuppressWarnings("serial")<a name="line.21"></a>
<span class="sourceLineNo">022</span>public final class HL7Field implements Serializable {<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>    /**<a name="line.24"></a>
<span class="sourceLineNo">025</span>     * The empty field.<a name="line.25"></a>
<span class="sourceLineNo">026</span>     */<a name="line.26"></a>
<span class="sourceLineNo">027</span>    public static final HL7Field EMPTY = new HL7Field("");<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>    protected final String[][][] value;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>    /**<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * Constructor.<a name="line.32"></a>
<span class="sourceLineNo">033</span>     *<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * @param value simple string value for this field; null is treated like the empty string<a name="line.34"></a>
<span class="sourceLineNo">035</span>     */<a name="line.35"></a>
<span class="sourceLineNo">036</span>    public HL7Field(String value) {<a name="line.36"></a>
<span class="sourceLineNo">037</span>        this(new String[][][] { { { value } } });<a name="line.37"></a>
<span class="sourceLineNo">038</span>    }<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>    /**<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * Constructor used to create a field containing zero or more repeated values, each a simple string value.<a name="line.41"></a>
<span class="sourceLineNo">042</span>     *<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @param repeats repeat values for this field; null is treated like the empty string<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * @throws IllegalArgumentException if &lt;code&gt;repeats&lt;/code&gt; array has length zero<a name="line.44"></a>
<span class="sourceLineNo">045</span>     */<a name="line.45"></a>
<span class="sourceLineNo">046</span>    public HL7Field(String[] repeats) {<a name="line.46"></a>
<span class="sourceLineNo">047</span>        this.value = new String[repeats.length][1][1];<a name="line.47"></a>
<span class="sourceLineNo">048</span>        for (int i = 0; i &lt; repeats.length; i++)<a name="line.48"></a>
<span class="sourceLineNo">049</span>            this.value[i][0][0] = repeats[i];<a name="line.49"></a>
<span class="sourceLineNo">050</span>        this.checkLengthsAndReplaceNulls();<a name="line.50"></a>
<span class="sourceLineNo">051</span>    }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>    /**<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * Constructor used to create a field containing zero or more repeated values, each containing zero or more components,<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * each component containing zero or more sub-components.<a name="line.55"></a>
<span class="sourceLineNo">056</span>     *<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * @param repeats repeat array, each containing a component array, each containing a sub-component array; null in any<a name="line.57"></a>
<span class="sourceLineNo">058</span>     *  String position is treated like the empty string<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @throws NullPointerException if any intermediate array element (i.e., not of type String) is null<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @throws IllegalArgumentException if &lt;code&gt;repeats&lt;/code&gt; array or any sub-array has length zero<a name="line.60"></a>
<span class="sourceLineNo">061</span>     */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    public HL7Field(String[][][] repeats) {<a name="line.62"></a>
<span class="sourceLineNo">063</span>        this.value = repeats;<a name="line.63"></a>
<span class="sourceLineNo">064</span>        this.checkLengthsAndReplaceNulls();<a name="line.64"></a>
<span class="sourceLineNo">065</span>    }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    /**<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * Parsing constructor.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     *<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * &lt;p&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * Parses the encoded HL7 field. Non-custom escapes will be decoded, while custom escapes will be silently removed.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     *<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @param field encoded HL7 field contents<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * @param seps HL7 separator characters<a name="line.74"></a>
<span class="sourceLineNo">075</span>     */<a name="line.75"></a>
<span class="sourceLineNo">076</span>    public HL7Field(String field, HL7Seps seps) {<a name="line.76"></a>
<span class="sourceLineNo">077</span>        int[] repSeps = HL7Util.find(field, seps.getRepSep());<a name="line.77"></a>
<span class="sourceLineNo">078</span>        this.value = new String[repSeps.length][][];<a name="line.78"></a>
<span class="sourceLineNo">079</span>        int repPosn = 0;<a name="line.79"></a>
<span class="sourceLineNo">080</span>        for (int i = 0; i &lt; repSeps.length; i++) {<a name="line.80"></a>
<span class="sourceLineNo">081</span>            int[] compSeps = HL7Util.find(field, seps.getCompSep(), repPosn, repSeps[i]);<a name="line.81"></a>
<span class="sourceLineNo">082</span>            this.value[i] = new String[compSeps.length][];<a name="line.82"></a>
<span class="sourceLineNo">083</span>            int compPosn = repPosn;<a name="line.83"></a>
<span class="sourceLineNo">084</span>            for (int j = 0; j &lt; compSeps.length; j++) {<a name="line.84"></a>
<span class="sourceLineNo">085</span>                if (!seps.hasSubcomponentSeparator()) {<a name="line.85"></a>
<span class="sourceLineNo">086</span>                    this.value[i][j] = new String[] { seps.unescape(field.substring(compPosn, compSeps[j])) };<a name="line.86"></a>
<span class="sourceLineNo">087</span>                    continue;<a name="line.87"></a>
<span class="sourceLineNo">088</span>                }<a name="line.88"></a>
<span class="sourceLineNo">089</span>                int[] subSeps = HL7Util.find(field, seps.getSubSep(), compPosn, compSeps[j]);<a name="line.89"></a>
<span class="sourceLineNo">090</span>                this.value[i][j] = new String[subSeps.length];<a name="line.90"></a>
<span class="sourceLineNo">091</span>                int subPosn = compPosn;<a name="line.91"></a>
<span class="sourceLineNo">092</span>                for (int k = 0; k &lt; subSeps.length; k++) {<a name="line.92"></a>
<span class="sourceLineNo">093</span>                    this.value[i][j][k] = seps.unescape(field.substring(subPosn, subSeps[k]));<a name="line.93"></a>
<span class="sourceLineNo">094</span>                    subPosn = subSeps[k] + 1;<a name="line.94"></a>
<span class="sourceLineNo">095</span>                }<a name="line.95"></a>
<span class="sourceLineNo">096</span>                compPosn = compSeps[j] + 1;<a name="line.96"></a>
<span class="sourceLineNo">097</span>            }<a name="line.97"></a>
<span class="sourceLineNo">098</span>            repPosn = repSeps[i] + 1;<a name="line.98"></a>
<span class="sourceLineNo">099</span>        }<a name="line.99"></a>
<span class="sourceLineNo">100</span>    }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>    /**<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * Copy constructor.<a name="line.103"></a>
<span class="sourceLineNo">104</span>     *<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * &lt;p&gt;<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * This constructor performs a deep copy of &lt;code&gt;field&lt;/code&gt;, so that subsequent changes to it do not affect this instance.<a name="line.106"></a>
<span class="sourceLineNo">107</span>     */<a name="line.107"></a>
<span class="sourceLineNo">108</span>    public HL7Field(HL7Field field) {<a name="line.108"></a>
<span class="sourceLineNo">109</span>        this.value = field.value.clone();<a name="line.109"></a>
<span class="sourceLineNo">110</span>        for (int i = 0; i &lt; this.value.length; i++) {<a name="line.110"></a>
<span class="sourceLineNo">111</span>            this.value[i] = this.value[i].clone();<a name="line.111"></a>
<span class="sourceLineNo">112</span>            for (int j = 0; j &lt; this.value.length; j++)<a name="line.112"></a>
<span class="sourceLineNo">113</span>                this.value[i][j] = this.value[i][j].clone();<a name="line.113"></a>
<span class="sourceLineNo">114</span>        }<a name="line.114"></a>
<span class="sourceLineNo">115</span>    }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>    /**<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * Get field contents.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     *<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * &lt;p&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * The length of the returned array, each of its array elements, and each of their sub-array elements,<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * is guaranteed to be at least one.<a name="line.122"></a>
<span class="sourceLineNo">123</span>     *<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * @return array of repeats, each an array of components, each an array of sub-components, each a non-null String.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     */<a name="line.125"></a>
<span class="sourceLineNo">126</span>    public String[][][] getValue() {<a name="line.126"></a>
<span class="sourceLineNo">127</span>        return this.value;<a name="line.127"></a>
<span class="sourceLineNo">128</span>    }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span>    public boolean isEmpty() {<a name="line.130"></a>
<span class="sourceLineNo">131</span>        return EMPTY.equals(this);<a name="line.131"></a>
<span class="sourceLineNo">132</span>    }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>    /**<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * Get a specific field sub-component.<a name="line.135"></a>
<span class="sourceLineNo">136</span>     *<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * @param repnum repeat number (zero-based)<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * @param compnum component number (zero-based)<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * @param subnum sub-component number (zero-based)<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * @return specified sub-component, or null if it does not exist<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @throws IllegalArgumentException if any parameter is negative<a name="line.141"></a>
<span class="sourceLineNo">142</span>     */<a name="line.142"></a>
<span class="sourceLineNo">143</span>    public String get(int repnum, int compnum, int subnum) {<a name="line.143"></a>
<span class="sourceLineNo">144</span>        if (repnum &lt; 0 || compnum &lt; 0 || subnum &lt; 0)<a name="line.144"></a>
<span class="sourceLineNo">145</span>            throw new IllegalArgumentException("negative index");<a name="line.145"></a>
<span class="sourceLineNo">146</span>        try {<a name="line.146"></a>
<span class="sourceLineNo">147</span>            return this.value[repnum][compnum][subnum];<a name="line.147"></a>
<span class="sourceLineNo">148</span>        } catch (ArrayIndexOutOfBoundsException e) {<a name="line.148"></a>
<span class="sourceLineNo">149</span>            return null;<a name="line.149"></a>
<span class="sourceLineNo">150</span>        }<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>    /**<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * Append properly separated and escaped version of this field<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * to the given buffer.<a name="line.155"></a>
<span class="sourceLineNo">156</span>     *<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * @param seps HL7 separator and escape characters<a name="line.157"></a>
<span class="sourceLineNo">158</span>     */<a name="line.158"></a>
<span class="sourceLineNo">159</span>    public void append(StringBuilder buf, HL7Seps seps) {<a name="line.159"></a>
<span class="sourceLineNo">160</span>        for (int i = 0; i &lt; this.value.length; i++) {<a name="line.160"></a>
<span class="sourceLineNo">161</span>            if (i &gt; 0)<a name="line.161"></a>
<span class="sourceLineNo">162</span>                buf.append(seps.getRepSep());<a name="line.162"></a>
<span class="sourceLineNo">163</span>            for (int j = 0; j &lt; this.value[i].length; j++) {<a name="line.163"></a>
<span class="sourceLineNo">164</span>                if (j &gt; 0)<a name="line.164"></a>
<span class="sourceLineNo">165</span>                    buf.append(seps.getCompSep());<a name="line.165"></a>
<span class="sourceLineNo">166</span>                for (int k = 0; k &lt; this.value[i][j].length; k++) {<a name="line.166"></a>
<span class="sourceLineNo">167</span>                    if (k &gt; 0)<a name="line.167"></a>
<span class="sourceLineNo">168</span>                        buf.append(seps.getSubSep());<a name="line.168"></a>
<span class="sourceLineNo">169</span>                    seps.escape(this.value[i][j][k], buf);<a name="line.169"></a>
<span class="sourceLineNo">170</span>                }<a name="line.170"></a>
<span class="sourceLineNo">171</span>            }<a name="line.171"></a>
<span class="sourceLineNo">172</span>        }<a name="line.172"></a>
<span class="sourceLineNo">173</span>    }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span>    /**<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * Convert to a string using the provided separators.<a name="line.176"></a>
<span class="sourceLineNo">177</span>     *<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * @param seps HL7 separator and escape characters<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * @return this field properly separated and escaped with &lt;code&gt;seps&lt;/code&gt;<a name="line.179"></a>
<span class="sourceLineNo">180</span>     */<a name="line.180"></a>
<span class="sourceLineNo">181</span>    public String toString(HL7Seps seps) {<a name="line.181"></a>
<span class="sourceLineNo">182</span>        StringBuilder buf = new StringBuilder();<a name="line.182"></a>
<span class="sourceLineNo">183</span>        this.append(buf, seps);<a name="line.183"></a>
<span class="sourceLineNo">184</span>        return buf.toString();<a name="line.184"></a>
<span class="sourceLineNo">185</span>    }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span>    /**<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * Convert to a string using {@link HL7Seps#DEFAULT}.<a name="line.188"></a>
<span class="sourceLineNo">189</span>     */<a name="line.189"></a>
<span class="sourceLineNo">190</span>    @Override<a name="line.190"></a>
<span class="sourceLineNo">191</span>    public String toString() {<a name="line.191"></a>
<span class="sourceLineNo">192</span>        return this.toString(HL7Seps.DEFAULT);<a name="line.192"></a>
<span class="sourceLineNo">193</span>    }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span>    @Override<a name="line.195"></a>
<span class="sourceLineNo">196</span>    public boolean equals(Object obj) {<a name="line.196"></a>
<span class="sourceLineNo">197</span>        if (!(obj instanceof HL7Field))<a name="line.197"></a>
<span class="sourceLineNo">198</span>            return false;<a name="line.198"></a>
<span class="sourceLineNo">199</span>        HL7Field that = (HL7Field)obj;<a name="line.199"></a>
<span class="sourceLineNo">200</span>        return Arrays.deepEquals(this.value, that.value);<a name="line.200"></a>
<span class="sourceLineNo">201</span>    }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span>    @Override<a name="line.203"></a>
<span class="sourceLineNo">204</span>    public int hashCode() {<a name="line.204"></a>
<span class="sourceLineNo">205</span>        return Arrays.deepHashCode(this.value);<a name="line.205"></a>
<span class="sourceLineNo">206</span>    }<a name="line.206"></a>
<span class="sourceLineNo">207</span><a name="line.207"></a>
<span class="sourceLineNo">208</span>    private void checkLengthsAndReplaceNulls() {<a name="line.208"></a>
<span class="sourceLineNo">209</span>        if (this.value.length == 0)<a name="line.209"></a>
<span class="sourceLineNo">210</span>            throw new IllegalArgumentException("zero length array");<a name="line.210"></a>
<span class="sourceLineNo">211</span>        for (int i = 0; i &lt; this.value.length; i++) {<a name="line.211"></a>
<span class="sourceLineNo">212</span>            if (this.value[i].length == 0)<a name="line.212"></a>
<span class="sourceLineNo">213</span>                throw new IllegalArgumentException("zero length sub-array");<a name="line.213"></a>
<span class="sourceLineNo">214</span>            for (int j = 0; j &lt; this.value[i].length; j++) {<a name="line.214"></a>
<span class="sourceLineNo">215</span>                if (this.value[i][j].length == 0)<a name="line.215"></a>
<span class="sourceLineNo">216</span>                    throw new IllegalArgumentException("zero length sub-array");<a name="line.216"></a>
<span class="sourceLineNo">217</span>                for (int k = 0; k &lt; this.value[i][j].length; k++) {<a name="line.217"></a>
<span class="sourceLineNo">218</span>                    String s = this.value[i][j][k];<a name="line.218"></a>
<span class="sourceLineNo">219</span>                    this.value[i][j][k] = s != null ? s : "";<a name="line.219"></a>
<span class="sourceLineNo">220</span>                }<a name="line.220"></a>
<span class="sourceLineNo">221</span>            }<a name="line.221"></a>
<span class="sourceLineNo">222</span>        }<a name="line.222"></a>
<span class="sourceLineNo">223</span>    }<a name="line.223"></a>
<span class="sourceLineNo">224</span>}<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>




























































</pre>
</div>
</body>
</html>
